Introduction
The Direct Interface provides direct access to semantic web technologies (SWT) for data manipulation within digital engineering frameworks, enabling developers to interact with ontology-aligned data repositories using standardized query and update mechanisms.
Overview
The Direct Interface is one of three interface types in the DEFII framework (Digital Engineering Framework for Integration and Interoperability), designed for direct interaction with the Semantic Web Technology (SWT) stack. Unlike the Mapping Interface (which starts with tool-specific data and maps it to ontologies) or the Specified Model Interface (which starts with ontologies and exposes data to tools), the Direct Interface provides direct access to the underlying data store through the SWT stack.
This interface is particularly useful for developers who require fine-grained control over data operations and are familiar with semantic web technologies. It uses direct invocation of the SWT stack to perform functions on the data, primarily through the SPARQL query language.
|
The Direct Interface offers greater flexibility but requires deeper knowledge of the underlying ontology structure and SWT concepts compared to other interface types. |
Position in Knowledge Hierarchy
Broader concepts: - Model Interface (is-a)
Details
The Direct Interface primarily utilizes the SPARQL query language to interact with the triplestore repository, which can be accessed via a REST API. The IoIF Core provides a standard "client" object for interacting with multiple triplestores using identical syntax.
The interface operates through the following key components:
Component |
Description |
SPARQL Engine |
Primary mechanism for querying and manipulating data in the triplestore |
REST API |
Standardized interface for accessing the triplestore repository |
Client Object |
Standardized object for interacting with multiple triplestores using identical syntax |
Triplestore Repository |
Underlying storage for ontology-aligned data |
The Direct Interface returns data in a standard JSON format with two top-level fields: - "head": Specifies variables bound to graph IRIs or literals - "results": Contains query results in a "bindings" array
|
The SPARQL query format follows the W3C standard, similar to SQL for relational databases but designed for graph data structures. |
|
The Direct Interface provides less "safety" compared to the Specified Model Interface, as it allows direct modification of the repository. Users must be cautious to avoid unintended data modifications. |
Practical applications and examples
Example: Querying Data with SPARQL
Here’s an example of using SPARQL to query data from a triplestore using the Direct Interface:
from ioif import IoIFClient
= Initialize the client with a specific repository
client = IoIFClient(repository="catapult_repo")
= SPARQL query to get all catapult arm lengths
query = """
SELECT ?armLength
WHERE {
?catapult a ioif:Catapult .
?catapult ioif:hasArmLength ?armLength .
}
"""
= Execute the query
results = client.execute_sparql(query)
= Process results
for row in results:
print(f"Catapult arm length: {row['armLength']}")Example: Updating Data with SPARQL
Here’s an example of updating data using the Direct Interface:
= Update catapult arm length
update_query = """
PREFIX ioif: <http://example.org/ioif#>
UPDATE {
?catapult ioif:hasArmLength ?oldLength .
}
WHERE {
?catapult a ioif:Catapult .
?catapult ioif:hasArmLength ?oldLength .
}
INSERT {
?catapult ioif:hasArmLength 3.5 .
}
"""
= Execute the update
client.execute_sparql(update_query)SPARQL Query Result Format
The SPARQL result JSON format follows this structure:
{
"head": {
"vars": ["armLength"]
},
"results": {
"bindings": [
{
"armLength": {
"type": "literal",
"value": "2.5"
}
},
{
"armLength": {
"type": "literal",
"value": "3.0"
}
}
]
}
}|
When using the Direct Interface, be cautious about the scope of your queries and updates. Unlike the Specified Model Interface, which enforces structure through MISD definitions, the Direct Interface allows for direct manipulation of the underlying graph structure. |
Related wiki pages
References
Knowledge Graph
Associated Diagrams
